[Docs] Improve and clarify npm link instructions in README (#999) #1082
Conversation
|
Thanks, @yashodipmore ! |
|
@M-DEV-1 will you review? |
| # Expected output: | ||
| # node_modules/@sistent/sistent -> ../../../../../sistent | ||
| ```bash | ||
| npm ls -g --depth=0 |
There was a problem hiding this comment.
Hi @yashodipmore, wouldn't it be better to not specify the --depth flag here?
| > [!NOTE] | ||
| > Avoid using `type any` in your code. Always specify explicit types to ensure type safety and maintainability. |
There was a problem hiding this comment.
Please revert this back, as this is a general tip, not related to local sistent forks.
|
@yashodipmore, the DCO check is failing, please signoff your commits. Ref: https://github.com/layer5io/sistent/pull/1082/checks?check_run_id=44296640731 |
|
|
||
| 1. Create a link of your local Sistent fork | ||
| The `npm link` workflow allows contributors to test their local changes in Sistent within projects like Meshery UI without publishing the package to npm. It creates a symbolic link from the global `node_modules` to your development version of Sistent, enabling fast feedback during development. |
There was a problem hiding this comment.
This description, of the npm link command is helpful, but I'm not sure what is new in this change, except this description, and the extra tips in the end. Could you explain maybe why you felt this change was necessary?
Co-authored-by: mahadevan <[email protected]> Signed-off-by: Rian the rizzler <[email protected]>
|
@yashodipmore The Dco Check is failing mind fixing it. |
|
🚨 Alert! Git Police! We couldn’t help but notice that one or more of your commits is missing a sign-off. A what? A commit sign-off (your email address). To amend the commits in this PR with your signoff using the instructions provided in the DCO check. To configure your dev environment to automatically signoff on your commits in the future, see these instructions.
|
Notes for Reviewers
This PR fixes #999
This PR improves the
npm linkinstructions in the README by adding a detailed, developer-friendly, and accurate workflow for contributors to test their local Sistent fork within Meshery or other projects.Signed commits